Allow Resource Files In Addition To Source Files #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
August 30, 2018 01:13
Major Changes: * introduce public `Code` struct * modify `(*context).Evaluate()` & `(*sandbox).run()` to accept `Code` struct * introduce logic to move source files and resource files into tmp mounted docker directory * refactored `cmd` and tests Notes: since we will be allowing the user's program to potentially write to a resource file, we should add some security to ensure that the program isn't dumping data into these files in an unbounded way. a malicious program might want to do that to use up al storage.
Major Changes: * introduce `constants.go` file to organize all package level consts * add comment in `context_test.go` distinguishing it as public API functional tests * organize whitebox tests into suites (using Testify library) which are invoked in `main_test.go` * test `(*sandbox).PrepareTmpDir()` against three cases: (1) user code supplied as string (2) user code supplied as file (3) user code supplied as file with resource files * test user code rewrite function, `(*sandbox).rewriteUserFiles()` * introduce `(*sandbox).copyFiles()` for copying files * introduce `(*sandbox).cleanup()` to be called after execution
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
currently we only allow users to submit source code and the
xaqtpublic API only allows code to be submitted via a stringified representation of the source rather than a filename. Since in some applications it may be necessary for the user submitted code to rely on external resources files (e.g. in machine learning applications where the source may need to read/write parameters to a file, etc.), this PR introduces support for adding an arbitrary number of external resource files. In actuality, these resource files could also be other source code files which the entrypoint source file imports or references. Additionally, we add the option of specifying source files rather than just stringified source code.Major Changes
Codestruct for describing the representation of submitted codeconstants.gofile (not very big right now but we should use it more in the future to avoid magic strings)Testifytest frameworkNotes
we may have to rebase onto master if PR #24 is merged first.
this PR resolves issue #22